Vapi Metadata Authentication AuthenticationInfo

Vapi Metadata Authentication AuthenticationInfo
Vapi Metadata Authentication AuthenticationInfo

The Vapi Metadata Authentication AuthenticationInfo schema describes the authentication information. Authentication information could be specified for a package element, service elenent or an operation element.

Using the authentication scheme information, a client invoking an API call from any resource can figure out what kind of credentials are needed for that API call.

JSON Example
{
    "scheme_type": "string",
    "session_manager": "string",
    "scheme": "string"
}
string
scheme_type
Required

The type of the authentication scheme.

For more information see: Vapi Metadata Authentication AuthenticationInfo SchemeType.

string
session_manager
Optional

In a session aware authentication scheme, a session manager is required that supports create, delete and keepAlive operations. The fully qualified resource name of the session manager is provided in Vapi Metadata Authentication AuthenticationInfo.session_manager property. This resource is responsible for handling sessions.

This property is optional and it is only relevant when the value of scheme_type is Vapi Metadata Authentication AuthenticationInfo SchemeType.SESSION_AWARE.

string
scheme
Required

String identifier of the authentication scheme.

Following are the supported authentication schemes by the infrastructure:

  • The identifier com.vmware.vapi.std.security.saml_hok_token for SAML holder of key token based authentication mechanism.
  • The identifier com.vmware.vapi.std.security.bearer_token for SAML bearer token based authentication mechanism.
  • The identifier com.vmware.vapi.std.security.session_id for session based authentication mechanism.
  • The identifier com.vmware.vapi.std.security.user_pass for username and password based authentication mechanism.
Property Of